Description

I have been using this flake locally to install flow-cli on NixOs and on NixDarvin. I think it might be nice to add it for anyone else trying to use the flow-cli in a nix environment.

I will also update the install documentation to include Nix.

Eventually I would like to add this to https://github.com/NixOS/nixpkgs. so its even easier to use.

The nix instructions (that I will put in the docs) would be:

Installing Flow CLI with Nix

The Flow CLI can be installed on NixOS and systems with Nix package manager using Nix flakes.

Prerequisites

Ensure you have Nix installed with flakes enabled. Add to /etc/nix/nix.conf or ~/.config/nix/nix.conf:

experimental-features = nix-command flakes

Installation Methods

1. Try Without Installing

Run the latest version directly:

nix run github:onflow/flow-cli

2. Install to User Profile

Install persistently:

nix profile install github:onflow/flow-cli

3. Use in NixOS Configuration

Add to your configuration.nix:

{
  inputs.flow-cli.url = "github:onflow/flow-cli";

  outputs = { self, nixpkgs, flow-cli, ... }: {
    nixosConfigurations.myhost = nixpkgs.lib.nixosSystem {
      modules = [
        {
          environment.systemPackages = [
            flow-cli.packages.x86_64-linux.default
          ];
        }
      ];
    };
  };
}

4. Use in Home Manager

Add to your flake inputs and home configuration:

{
  inputs.flow-cli.url = "github:onflow/flow-cli";

  outputs = { self, nixpkgs, home-manager, flow-cli, ... }: {
    homeConfigurations.myuser = home-manager.lib.homeManagerConfiguration {
      pkgs = nixpkgs.legacyPackages.x86_64-linux;
      modules = [
        {
          home.packages = [
            flow-cli.packages.x86_64-linux.default
          ];
        }
      ];
    };
  };
}

5. Development Shell

Enter a development environment with Flow CLI and Go tooling:

nix develop github:onflow/flow-cli

Or for local development:

cd flow-cli
nix develop

Installing Specific Versions

Install a specific version using git tags:

nix profile install github:onflow/flow-cli/v2.14.2

The flake automatically extracts the version from the git tag when building from a tagged ref.

Upgrading

Update to the latest version:

nix profile upgrade flow-cli

Uninstalling

Remove from profile:

nix profile remove flow-cli

For contributor use:

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work
• Code follows the standards mentioned here
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels